<?xml version='1.0' encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <link href="cpip.css" rel="stylesheet" type="text/css" />
    <title>File: /Users/paulross/dev/Python-3.6.2/Include/listobject.h</title>
  </head>
  <body>
    <h1>File: /Users/paulross/dev/Python-3.6.2/Include/listobject.h</h1>
    <p>Green shading in the line number column
means the source is part of the translation unit, red means it is conditionally excluded.
Highlighted line numbers link to the translation unit page. Highlighted macros link to
the macro page.</p>
    <pre><a name="1" /><span class="True">       1:</span> 
<a name="2" /><span class="True">       2:</span> <span class="k">/* List object interface */</span>
<a name="3" /><span class="True">       3:</span> 
<a name="4" /><span class="True">       4:</span> <span class="k">/*</span>
<a name="5" /><span class="True">       5:</span> <span class="k">Another generally useful object type is a list of object pointers.</span>
<a name="6" /><span class="True">       6:</span> <span class="k">This is a mutable type: the list items can be changed, and items can be</span>
<a name="7" /><span class="True">       7:</span> <span class="k">added or removed.  Out-of-range indices or non-list objects are ignored.</span>
<a name="8" /><span class="True">       8:</span> <span class="k"></span>
<a name="9" /><span class="True">       9:</span> <span class="k">*** WARNING *** PyList_SetItem does not increment the new item&apos;s reference</span>
<a name="10" /><span class="True">      10:</span> <span class="k">count, but does decrement the reference count of the item it replaces,</span>
<a name="11" /><span class="True">      11:</span> <span class="k">if not nil.  It does *decrement* the reference count if it is *not*</span>
<a name="12" /><span class="True">      12:</span> <span class="k">inserted in the list.  Similarly, PyList_GetItem does not increment the</span>
<a name="13" /><span class="True">      13:</span> <span class="k">returned item&apos;s reference count.</span>
<a name="14" /><span class="True">      14:</span> <span class="k">*/</span>
<a name="15" /><span class="True">      15:</span> 
<a name="16" /><span class="True">      16:</span> <span class="f">#</span><span class="n">ifndef</span> <a href="macros_noref.html#_UHlfTElTVE9CSkVDVF9IXzA_"><span class="b">Py_LISTOBJECT_H</span></a>
<a name="17" /><span class="True">      17:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_noref.html#_UHlfTElTVE9CSkVDVF9IXzA_"><span class="b">Py_LISTOBJECT_H</span></a>
<a name="18" /><span class="False">      18:</span> <span class="f">#</span><span class="n">ifdef</span> <span class="b">__cplusplus</span>
<a name="19" /><span class="False">      19:</span> <span class="m">extern</span> <span class="e">&quot;C&quot;</span> <span class="f">{</span>
<a name="20" /><span class="True">      20:</span> <span class="f">#</span><span class="n">endif</span>
<a name="21" /><span class="True">      21:</span> 
<a name="22" /><span class="True">      22:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="23" /><span class="True">      23:</span> <span class="m">typedef</span> <span class="m">struct</span> <span class="f">{</span>
<a name="24" /><span class="True">      24:</span>     <a href="macros_ref.html#_UHlPYmplY3RfVkFSX0hFQURfMA__"><span class="b">PyObject_VAR_HEAD</span></a>
<a name="25" /><span class="True">      25:</span>     <span class="k">/* Vector of pointers to list elements.  list[0] is ob_item[0], etc. */</span>
<a name="26" /><span class="True">      26:</span>     <span class="b">PyObject</span> <span class="f">*</span><span class="f">*</span><span class="b">ob_item</span><span class="f">;</span>
<a name="27" /><span class="True">      27:</span> 
<a name="28" /><span class="True">      28:</span>     <span class="k">/* ob_item contains space for &apos;allocated&apos; elements.  The number</span>
<a name="29" /><span class="True">      29:</span> <span class="k">     * currently in use is ob_size.</span>
<a name="30" /><span class="True">      30:</span> <span class="k">     * Invariants:</span>
<a name="31" /><span class="True">      31:</span> <span class="k">     *     0 &lt;= ob_size &lt;= allocated</span>
<a name="32" /><span class="True">      32:</span> <span class="k">     *     len(list) == ob_size</span>
<a name="33" /><span class="True">      33:</span> <span class="k">     *     ob_item == NULL implies ob_size == allocated == 0</span>
<a name="34" /><span class="True">      34:</span> <span class="k">     * list.sort() temporarily sets allocated to -1 to detect mutations.</span>
<a name="35" /><span class="True">      35:</span> <span class="k">     *</span>
<a name="36" /><span class="True">      36:</span> <span class="k">     * Items must normally not be NULL, except during construction when</span>
<a name="37" /><span class="True">      37:</span> <span class="k">     * the list is not yet visible outside the function that builds it.</span>
<a name="38" /><span class="True">      38:</span> <span class="k">     */</span>
<a name="39" /><span class="True">      39:</span>     <span class="b">Py_ssize_t</span> <span class="b">allocated</span><span class="f">;</span>
<a name="40" /><span class="True">      40:</span> <span class="f">}</span> <span class="b">PyListObject</span><span class="f">;</span>
<a name="41" /><span class="True">      41:</span> <span class="f">#</span><span class="n">endif</span>
<a name="42" /><span class="True">      42:</span> 
<a name="43" /><span class="True">      43:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PyList_Type</span><span class="f">;</span>
<a name="44" /><span class="True">      44:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PyListIter_Type</span><span class="f">;</span>
<a name="45" /><span class="True">      45:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PyListRevIter_Type</span><span class="f">;</span>
<a name="46" /><span class="True">      46:</span> <a href="macros_ref.html#_UHlBUElfREFUQV8w"><span class="b">PyAPI_DATA</span></a><span class="f">(</span><span class="b">PyTypeObject</span><span class="f">)</span> <span class="b">PySortWrapper_Type</span><span class="f">;</span>
<a name="47" /><span class="True">      47:</span> 
<a name="48" /><span class="True">      48:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlMaXN0X0NoZWNrXzA_"><span class="b">PyList_Check</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> \
<a name="49" /><span class="True">      49:</span>     <a href="macros_ref.html#_UHlUeXBlX0Zhc3RTdWJjbGFzc18w"><span class="b">PyType_FastSubclass</span></a><span class="f">(</span><a href="macros_ref.html#_UHlfVFlQRV8w"><span class="b">Py_TYPE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">,</span> <a href="macros_ref.html#_UHlfVFBGTEFHU19MSVNUX1NVQkNMQVNTXzA_"><span class="b">Py_TPFLAGS_LIST_SUBCLASS</span></a><span class="f">)</span>
<a name="50" /><span class="True">      50:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_noref.html#_UHlMaXN0X0NoZWNrRXhhY3RfMA__"><span class="b">PyList_CheckExact</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> <span class="f">(</span><a href="macros_ref.html#_UHlfVFlQRV8w"><span class="b">Py_TYPE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span> <span class="f">==</span> <span class="f">&amp;</span><span class="b">PyList_Type</span><span class="f">)</span>
<a name="51" /><span class="True">      51:</span> 
<a name="52" /><span class="True">      52:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyList_New</span><span class="f">(</span><span class="b">Py_ssize_t</span> <span class="b">size</span><span class="f">)</span><span class="f">;</span>
<a name="53" /><span class="True">      53:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">Py_ssize_t</span><span class="f">)</span> <span class="b">PyList_Size</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="54" /><span class="True">      54:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyList_GetItem</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">)</span><span class="f">;</span>
<a name="55" /><span class="True">      55:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_SetItem</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="56" /><span class="True">      56:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_Insert</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="57" /><span class="True">      57:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_Append</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="58" /><span class="True">      58:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyList_GetSlice</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">)</span><span class="f">;</span>
<a name="59" /><span class="True">      59:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_SetSlice</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">Py_ssize_t</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="60" /><span class="True">      60:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_Sort</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="61" /><span class="True">      61:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_Reverse</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="62" /><span class="True">      62:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">PyList_AsTuple</span><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="63" /><span class="True">      63:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="64" /><span class="True">      64:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span> <span class="b">_PyList_Extend</span><span class="f">(</span><span class="b">PyListObject</span> <span class="f">*</span><span class="f">,</span> <span class="b">PyObject</span> <span class="f">*</span><span class="f">)</span><span class="f">;</span>
<a name="65" /><span class="True">      65:</span> 
<a name="66" /><span class="True">      66:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">int</span><span class="f">)</span> <span class="b">PyList_ClearFreeList</span><span class="f">(</span><span class="m">void</span><span class="f">)</span><span class="f">;</span>
<a name="67" /><span class="True">      67:</span> <a href="macros_ref.html#_UHlBUElfRlVOQ18w"><span class="b">PyAPI_FUNC</span></a><span class="f">(</span><span class="m">void</span><span class="f">)</span> <span class="b">_PyList_DebugMallocStats</span><span class="f">(</span><span class="b">FILE</span> <span class="f">*</span><span class="b">out</span><span class="f">)</span><span class="f">;</span>
<a name="68" /><span class="True">      68:</span> <span class="f">#</span><span class="n">endif</span>
<a name="69" /><span class="True">      69:</span> 
<a name="70" /><span class="True">      70:</span> <span class="k">/* Macro, trading safety for speed */</span>
<a name="71" /><span class="True">      71:</span> <span class="f">#</span><span class="n">ifndef</span> <span class="b">Py_LIMITED_API</span>
<a name="72" /><span class="True">      72:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlMaXN0X0dFVF9JVEVNXzA_"><span class="b">PyList_GET_ITEM</span></a><span class="f">(</span><span class="b">op</span><span class="f">,</span> <span class="b">i</span><span class="f">)</span> <span class="f">(</span><span class="f">(</span><span class="f">(</span><span class="b">PyListObject</span> <span class="f">*</span><span class="f">)</span><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">)</span><span class="f">-&gt;</span><span class="b">ob_item</span><span class="f">[</span><span class="b">i</span><span class="f">]</span><span class="f">)</span>
<a name="73" /><span class="True">      73:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlMaXN0X1NFVF9JVEVNXzA_"><span class="b">PyList_SET_ITEM</span></a><span class="f">(</span><span class="b">op</span><span class="f">,</span> <span class="b">i</span><span class="f">,</span> <span class="b">v</span><span class="f">)</span> <span class="f">(</span><span class="f">(</span><span class="f">(</span><span class="b">PyListObject</span> <span class="f">*</span><span class="f">)</span><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">)</span><span class="f">-&gt;</span><span class="b">ob_item</span><span class="f">[</span><span class="b">i</span><span class="f">]</span> <span class="f">=</span> <span class="f">(</span><span class="b">v</span><span class="f">)</span><span class="f">)</span>
<a name="74" /><span class="True">      74:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_ref.html#_UHlMaXN0X0dFVF9TSVpFXzA_"><span class="b">PyList_GET_SIZE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span>    <a href="macros_ref.html#_UHlfU0laRV8w"><span class="b">Py_SIZE</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span>
<a name="75" /><span class="True">      75:</span> <span class="f">#</span><span class="n">define</span> <a href="macros_noref.html#_X1B5TGlzdF9JVEVNU18w"><span class="b">_PyList_ITEMS</span></a><span class="f">(</span><span class="b">op</span><span class="f">)</span>      <span class="f">(</span><span class="f">(</span><span class="f">(</span><span class="b">PyListObject</span> <span class="f">*</span><span class="f">)</span><span class="f">(</span><span class="b">op</span><span class="f">)</span><span class="f">)</span><span class="f">-&gt;</span><span class="b">ob_item</span><span class="f">)</span>
<a name="76" /><span class="True">      76:</span> <span class="f">#</span><span class="n">endif</span>
<a name="77" /><span class="True">      77:</span> 
<a name="78" /><span class="False">      78:</span> <span class="f">#</span><span class="n">ifdef</span> <span class="b">__cplusplus</span>
<a name="79" /><span class="False">      79:</span> <span class="f">}</span>
<a name="80" /><span class="True">      80:</span> <span class="f">#</span><span class="n">endif</span>
<a name="81" /><span class="True">      81:</span> <span class="f">#</span><span class="n">endif</span> <span class="k">/* !Py_LISTOBJECT_H */</span>
<a name="82" /><span class="True">      82:</span> </pre>
  </body>
</html>
